home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / bbs / tuhm101.zip / TUHM.DOC < prev    next >
Text File  |  1996-07-01  |  5KB  |  132 lines
  1.  
  2.                      The Ultimate Hypertext Manager
  3.                       Version 1.01 (25 April 1996)
  4.  
  5.  
  6. 1. Functionality:
  7.  
  8. This program introduces the notion of (elementary) hypertext to BBS's
  9. running RemoteAccess (RA).  Sysops can write their own text files
  10. (e.g., online help for their users) and link them together.  With the
  11. registered version of this program, sysops also have the possibility
  12. of letting their users start selected programs from within these text
  13. files.
  14.  
  15. 2. Syntax:
  16.  
  17. A link to another document (file) is inserted as follows:
  18.  
  19.         <href=filename><text to appear on screen>
  20.  
  21. where 'filename' stands for the name of the file that must be opened
  22. when the user selects this item, and 'text to appear on screen' is
  23. what the user will see.
  24.  
  25. A selection that will launch another program looks as follows:
  26.  
  27.         <shell=commandline><text to appear on screen>
  28.  
  29. with the same conventions as before.  The extension (.EXE, .COM, or .BAT)
  30. MUST be specified.  'commandline' can contain SOME of the parameter
  31. specifications that RA allows (namely *b, *n, *p, *t, and *o).  TUHM will
  32. expand these the same way RA does.
  33.  
  34. Note that an href/shell must be specified on a single line (i.e., you
  35. cannot split the definition across lines).
  36.  
  37. Registered users can add color to their text by inserting ^1, ^2, ^3,
  38. or ^4 just before where they want the color to change (actually, even
  39. unregistered users can do this, but it will have no effect).  When no
  40. color is specified, the default color 1 is used.  The colors can be
  41. specified with the TUHMCFG program, though only registered users will
  42. notice a difference when running TUHM.  (Note that ANSI.SYS, or the
  43. equivalent, must be loaded for TUHMCFG to run properly.
  44.  
  45. 3. Example:
  46.  
  47. The following text gives the user a simple menu from which he can choose
  48. several possibilities:
  49.  
  50. 1. Get some help about <href=c:\ra\tuhm\tuhm.hlp><using TUHM>
  51. 2. Launch <shell=c:\games\addictive.exe><an addictive game>
  52. 3. Get some ^2help^1 about <href=c:\ra\mybbs.txt><finding your way around this BBS>
  53.  
  54. The first and third lines will open the specified files (when the user
  55. selects them), while the second one will start a program.
  56.  
  57. The word 'help' on the third line will be colored differently (color 2,
  58. a color specified by the sysop, will be used).
  59.  
  60. Finally, the files 'Example.txt' and 'Example2.txt', included in the
  61. archive, are an example of two files that are linked.
  62.  
  63. 4. Installing the program :
  64.  
  65. You can place the program in any directory; the only thing that you
  66. must do to give users access to the program is installing it as a door
  67. program in RA.  Assuming that you installed it in a directory called
  68. TUHM, the command line you specify would look like this:
  69.  
  70.         C:\TUHM\TUHM.EXE *! filename
  71.  
  72. 'filename' is the path and name of the file that you want your users
  73. to see when starting the program.  For example, it could be a file
  74. containing the example lines above.  The '*!' freezes RA's timer,
  75. which is necessary because TUHM does its own time management.
  76.  
  77. Registered users receive a key file (TUHM.KEY).  This file MUST be
  78. placed in the RA root directory (the one to which the RA environment
  79. variable points).
  80.  
  81. 5. Keypad:
  82.  
  83. The following keys are available to the users :
  84.  
  85.   * Tab, Arrow Up, 8          => next link/shell in same file
  86.   * Shift Tab, Arrow Down, 2  => previous link/shell in same file
  87.   * Enter, Right arrow, 6     => follow link
  88.   * Esc, Left Arrow, 4        => return one level
  89.   * Page Down, 3              => next page
  90.   * Page Up, 9                => previous page
  91.  
  92. 6. Registration:
  93.  
  94. And now for the big surprise...  Registration only costs 100 BF (fl 6,
  95. 5 US$, 3 GBP), except for the French who will have to pay 100 FF (eat
  96. your heart out Chirac).
  97.  
  98. This money should, one way or another, come in the hands of the author.
  99.  
  100.         e-mail:  vancamp@rma.ac.be
  101.                  frankvc@glo.be
  102.         Fido:    2:292/8013.2
  103.  
  104. You may send your registration directly to him at the following address:
  105.  
  106.         Frank Van Camp
  107.         Beekvelden 25
  108.         2840 Reet
  109.         Belgium
  110.  
  111.         Bank account:  979-3710633-97 (Argenta bank in Belgium)
  112.  
  113. US residents may register in US$ using check, money order, MasterCard, or
  114. VISA (send cash at your own risk) with Brazerko Communications.
  115. See BRAZERKO.REG for an order form.  If the order form is missing you
  116. can contact us at sales@brazerko.com, 1:320/42, +1 860 892 INET (voice),
  117. or +1 860 886 1441 (Sea of Noise BBS).
  118.  
  119. In order to make the key-file, we need the following information:
  120.  
  121.         sysop name
  122.         BBS name
  123.         Fido-address
  124.  
  125. This information must be EXACTLY as it appears in your RA settings
  126. (i.e., case sensitive, including all commas and periods).
  127.  
  128. The key will be sent to you through netmail (or e-mail).  Just copy that
  129. file to your RA directory and your program becomes a registered one and
  130. all the features become available.
  131.  
  132.